Update GitHub issue and PR templates by renecannao · Pull Request #10 · ProxySQL/orchestrator

renecannao · 2026-03-23T21:06:43Z

Summary

Replace the single .github/ISSUE_TEMPLATE.md with three structured templates: bug report, feature request, and question
Update .github/PULL_REQUEST_TEMPLATE.md to reference proxysql/orchestrator, link to CONTRIBUTING.md, and include a proper checklist (gofmt, tests, CI, DCO sign-off, issue link)

Closes #4

Test plan

Verify the old ISSUE_TEMPLATE.md is removed
Verify new issue creation on GitHub shows the three template options
Verify PR template renders correctly with updated URLs and checklist

coderabbitai · 2026-03-23T21:06:50Z

Warning

Rate limit exceeded

@renecannao has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 0 minutes and 23 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fbc6ac00-d21e-4c9d-aa6f-83bd81ec7bc0

📥 Commits

Reviewing files that changed from the base of the PR and between 9e99dd6 and 87a8517.

📒 Files selected for processing (5)

.github/ISSUE_TEMPLATE.md
.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature_request.md
.github/ISSUE_TEMPLATE/question.md
.github/PULL_REQUEST_TEMPLATE.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch task4-github-templates

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

gemini-code-assist · 2026-03-23T21:07:01Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refines the project's contribution guidelines by overhauling the GitHub issue and pull request templates. The changes aim to provide clearer, more structured pathways for users to report bugs, request features, ask questions, and submit code contributions, thereby improving the overall quality and efficiency of community interactions and streamlining the review process.

Highlights

Issue Templates Restructured: The single, generic ISSUE_TEMPLATE.md has been replaced with three distinct, structured templates: bug_report.md, feature_request.md, and question.md to streamline issue submission and provide clearer guidance.
Pull Request Template Enhanced: The PULL_REQUEST_TEMPLATE.md has been updated to reference the correct proxysql/orchestrator repository, include a link to CONTRIBUTING.md, and incorporate a comprehensive checklist for PR submissions, covering formatting, tests, CI, DCO sign-off, and issue linking.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request significantly improves the contribution experience by introducing structured issue templates for bug reports, feature requests, and questions. It also updates the pull request template with a clearer checklist and correct repository links. The changes enhance the clarity and guidance for contributors, streamlining the process of reporting issues and submitting pull requests.

gemini-code-assist · 2026-03-23T21:08:23Z

+-->

-This PR [briefly explain what is does]
+Related issue: https://github.com/proxysql/orchestrator/issues/


To make it clearer for contributors, consider adding a placeholder for the issue number in the Related issue link. This would guide them on where to insert the relevant issue ID.

Suggested change

Related issue: https://github.com/proxysql/orchestrator/issues/

Related issue: https://github.com/proxysql/orchestrator/issues/<ISSUE_NUMBER>

Copilot

Pull request overview

Updates the repository’s GitHub contribution UX by replacing the single legacy issue template with three categorized templates and modernizing the pull request template to match the proxysql/orchestrator fork and expected contribution checks.

Changes:

Replace .github/ISSUE_TEMPLATE.md with separate Bug Report, Feature Request, and Question templates under .github/ISSUE_TEMPLATE/.
Update the PR template to reference proxysql/orchestrator and add a contribution checklist (formatting, tests, CI, DCO, issue link).

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
.github/PULL_REQUEST_TEMPLATE.md	Rewords the intro comment, updates issue URL base, and adds a checklist; introduces a reference to `CONTRIBUTING.md`.
.github/ISSUE_TEMPLATE/bug_report.md	Adds a structured bug report template requesting env/config/topology/logs.
.github/ISSUE_TEMPLATE/feature_request.md	Adds a structured feature request template (problem/solution/alternatives/context).
.github/ISSUE_TEMPLATE/question.md	Adds a question template with a docs link and basic section header.
.github/ISSUE_TEMPLATE.md	Removes the old single-file issue template.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-23T21:08:59Z

+Please read CONTRIBUTING.md before submitting your PR.



The template asks contributors to read CONTRIBUTING.md, but that file doesn’t exist in the repository right now, so this will be a dead reference. Either add CONTRIBUTING.md in this PR, or change this line to link to an existing contribution guide (or remove it until the file lands).

Suggested change

Please read CONTRIBUTING.md before submitting your PR.

Copilot · 2026-03-23T21:08:59Z

+-->

-This PR [briefly explain what is does]
+Related issue: https://github.com/proxysql/orchestrator/issues/


Related issue: currently points to the repository’s issue list, not to an actual issue (and doesn’t provide a placeholder format). Update this to an issue reference placeholder that GitHub will auto-link (e.g., Related issue: #<number> / Closes #<number>), so PRs consistently connect to a specific tracking issue.

Suggested change

Related issue: https://github.com/proxysql/orchestrator/issues/

Related issue: #<issue-number>

Copilot · 2026-03-23T21:08:59Z

+labels: question
+---
+
+> **Note:** Please check the [orchestrator documentation](https://github.com/proxysql/orchestrator/tree/master/docs) before asking your question — it may already be answered there.


This documentation link hard-codes the master branch. If the default branch is main (or changes again later), this will break. Prefer a branch-agnostic relative link to the docs directory (or a URL that tracks the default branch).

Suggested change

> **Note:** Please check the [orchestrator documentation](https://github.com/proxysql/orchestrator/tree/master/docs) before asking your question — it may already be answered there.

> **Note:** Please check the [orchestrator documentation](../../docs) before asking your question — it may already be answered there.

Copilot AI review requested due to automatic review settings March 23, 2026 21:06

Copilot started reviewing on behalf of renecannao March 23, 2026 21:07 View session

gemini-code-assist bot reviewed Mar 23, 2026

View reviewed changes

Copilot AI reviewed Mar 23, 2026

View reviewed changes

Refresh GitHub issue and PR templates

87a8517

renecannao force-pushed the task4-github-templates branch from 41af992 to 87a8517 Compare March 23, 2026 22:29

renecannao merged commit 72b3a08 into master Mar 23, 2026
1 of 4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update GitHub issue and PR templates#10

Update GitHub issue and PR templates#10
renecannao merged 1 commit intomasterfrom
task4-github-templates

renecannao commented Mar 23, 2026

Uh oh!

coderabbitai bot commented Mar 23, 2026 •

edited

Loading

Rate limit exceeded

Uh oh!

gemini-code-assist bot commented Mar 23, 2026

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Mar 23, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 23, 2026

Uh oh!

Copilot AI Mar 23, 2026

Uh oh!

Copilot AI Mar 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	Related issue: https://github.com/proxysql/orchestrator/issues/
	Related issue: https://github.com/proxysql/orchestrator/issues/<ISSUE_NUMBER>

	Related issue: https://github.com/proxysql/orchestrator/issues/
	Related issue: #<issue-number>

	> Note: Please check the [orchestrator documentation](https://github.com/proxysql/orchestrator/tree/master/docs) before asking your question — it may already be answered there.
	> Note: Please check the [orchestrator documentation](../../docs) before asking your question — it may already be answered there.

Conversation

renecannao commented Mar 23, 2026

Summary

Test plan

Uh oh!

coderabbitai bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Uh oh!

gemini-code-assist bot commented Mar 23, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

coderabbitai bot commented Mar 23, 2026 •

edited

Loading